Meshtastic App/com.geeksville.mesh/[androidJvm]ChannelProtos/ChannelSettings/Builder

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , ChannelProtos.ChannelSettingsOrBuilder


This information can be encoded as a QRcode/url so that other users can configure
their radio to join the same channel.
A note about how channel names are shown to users: channelname-X
poundsymbol is a prefix used to indicate this is a channel name (idea from @professr).
Where X is a letter from A-Z (base 26) representing a hash of the PSK for this
channel - so that if the user changes anything about the channel (which does
force a new PSK) this letter will also change. Thus preventing user confusion if
two friends try to type in a channel name of "BobsChan" and then can't talk
because their PSKs will be different.
The PSK is hashed into this letter by "0x41 + [xor all bytes of the psk ] modulo 26"
This also allows the option of someday if people have the PSK off (zero), the
users COULD type in a channel name and be able to talk.
FIXME: Add description of multi-channel support and how primary vs secondary channels are used.
FIXME: explain how apps use channels for security.
explain how remote settings and remote gpio are managed as an example

Protobuf type meshtastic.ChannelSettings

Functions

build

open fun build(): ChannelProtos.ChannelSettings

buildPartial

open fun buildPartial(): ChannelProtos.ChannelSettings

clear

open fun clear(): ChannelProtos.ChannelSettings.Builder

clearChannelNum

open fun ~~clearChannelNum~~(): ChannelProtos.ChannelSettings.Builder


Deprecated in favor of LoraConfig.channel_num

uint32 channel_num = 1 [deprecated = true];

clearDownlinkEnabled

open fun clearDownlinkEnabled(): ChannelProtos.ChannelSettings.Builder


If true, messages seen on the internet will be forwarded to the local mesh.

bool downlink_enabled = 6;

clearId

open fun clearId(): ChannelProtos.ChannelSettings.Builder


Used to construct a globally unique channel ID.
The full globally unique ID will be: "name.id" where ID is shown as base36.
Assuming that the number of meshtastic users is below 20K (true for a long time)
the chance of this 64 bit random number colliding with anyone else is super low.
And the penalty for collision is low as well, it just means that anyone trying to decrypt channel messages might need to
try multiple candidate channels.
Any time a non wire compatible change is made to a channel, this field should be regenerated.
There are a small number of 'special' globally known (and fairly) insecure standard channels.
Those channels do not have a numeric id included in the settings, but instead it is pulled from
a table of well known IDs.
(see Well Known Channels FIXME)

fixed32 id = 4;

clearModuleSettings

open fun clearModuleSettings(): ChannelProtos.ChannelSettings.Builder


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

clearName

open fun clearName(): ChannelProtos.ChannelSettings.Builder


A SHORT name that will be packed into the URL.
Less than 12 bytes.
Something for end users to call the channel
If this is the empty string it is assumed that this channel
is the special (minimally secure) "Default"channel.
In user interfaces it should be rendered as a local language translation of "X".
For channel_num hashing empty string will be treated as "X".
Where "X" is selected based on the English words listed above for ModemPreset

string name = 3;

clearPsk

open fun clearPsk(): ChannelProtos.ChannelSettings.Builder


A simple pre-shared key for now for crypto.
Must be either 0 bytes (no crypto), 16 bytes (AES128), or 32 bytes (AES256).
A special shorthand is used for 1 byte long psks.
These psks should be treated as only minimally secure,
because they are listed in this source code.
Those bytes are mapped using the following scheme:
`0` = No crypto
`1` = The special "default" channel key: {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59, 0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01}
`2` through 10 = The default channel key, except with 1 through 9 added to the last byte.
Shown to user as simple1 through 10

bytes psk = 2;

clearUplinkEnabled

open fun clearUplinkEnabled(): ChannelProtos.ChannelSettings.Builder


If true, messages on the mesh will be sent to the *public* internet by any gateway ndoe

bool uplink_enabled = 5;

getChannelNum

open fun ~~getChannelNum~~(): Int


Deprecated in favor of LoraConfig.channel_num

uint32 channel_num = 1 [deprecated = true];

getDefaultInstanceForType

open fun getDefaultInstanceForType(): ChannelProtos.ChannelSettings

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getDescriptorForType

open fun getDescriptorForType(): Descriptors.Descriptor

getDownlinkEnabled

open fun getDownlinkEnabled(): Boolean


If true, messages seen on the internet will be forwarded to the local mesh.

bool downlink_enabled = 6;

getId

open fun getId(): Int


Used to construct a globally unique channel ID.
The full globally unique ID will be: "name.id" where ID is shown as base36.
Assuming that the number of meshtastic users is below 20K (true for a long time)
the chance of this 64 bit random number colliding with anyone else is super low.
And the penalty for collision is low as well, it just means that anyone trying to decrypt channel messages might need to
try multiple candidate channels.
Any time a non wire compatible change is made to a channel, this field should be regenerated.
There are a small number of 'special' globally known (and fairly) insecure standard channels.
Those channels do not have a numeric id included in the settings, but instead it is pulled from
a table of well known IDs.
(see Well Known Channels FIXME)

fixed32 id = 4;

getModuleSettings

open fun getModuleSettings(): ChannelProtos.ModuleSettings


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

getModuleSettingsBuilder

open fun getModuleSettingsBuilder(): ChannelProtos.ModuleSettings.Builder


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

getModuleSettingsOrBuilder

open fun getModuleSettingsOrBuilder(): ChannelProtos.ModuleSettingsOrBuilder


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

getName

open fun getName(): String


A SHORT name that will be packed into the URL.
Less than 12 bytes.
Something for end users to call the channel
If this is the empty string it is assumed that this channel
is the special (minimally secure) "Default"channel.
In user interfaces it should be rendered as a local language translation of "X".
For channel_num hashing empty string will be treated as "X".
Where "X" is selected based on the English words listed above for ModemPreset

string name = 3;

getNameBytes

open fun getNameBytes(): ByteString


A SHORT name that will be packed into the URL.
Less than 12 bytes.
Something for end users to call the channel
If this is the empty string it is assumed that this channel
is the special (minimally secure) "Default"channel.
In user interfaces it should be rendered as a local language translation of "X".
For channel_num hashing empty string will be treated as "X".
Where "X" is selected based on the English words listed above for ModemPreset

string name = 3;

getPsk

open fun getPsk(): ByteString


A simple pre-shared key for now for crypto.
Must be either 0 bytes (no crypto), 16 bytes (AES128), or 32 bytes (AES256).
A special shorthand is used for 1 byte long psks.
These psks should be treated as only minimally secure,
because they are listed in this source code.
Those bytes are mapped using the following scheme:
`0` = No crypto
`1` = The special "default" channel key: {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59, 0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01}
`2` through 10 = The default channel key, except with 1 through 9 added to the last byte.
Shown to user as simple1 through 10

bytes psk = 2;

getUplinkEnabled

open fun getUplinkEnabled(): Boolean


If true, messages on the mesh will be sent to the *public* internet by any gateway ndoe

bool uplink_enabled = 5;

hasModuleSettings

open fun hasModuleSettings(): Boolean


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

isInitialized

fun isInitialized(): Boolean

mergeFrom

open fun mergeFrom(other: ChannelProtos.ChannelSettings): ChannelProtos.ChannelSettings.Builder

open fun mergeFrom(other: Message): ChannelProtos.ChannelSettings.Builder

open fun mergeFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): ChannelProtos.ChannelSettings.Builder

mergeModuleSettings

open fun mergeModuleSettings(value: ChannelProtos.ModuleSettings): ChannelProtos.ChannelSettings.Builder


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

setChannelNum

open fun ~~setChannelNum~~(value: Int): ChannelProtos.ChannelSettings.Builder


Deprecated in favor of LoraConfig.channel_num

uint32 channel_num = 1 [deprecated = true];

setDownlinkEnabled

open fun setDownlinkEnabled(value: Boolean): ChannelProtos.ChannelSettings.Builder


If true, messages seen on the internet will be forwarded to the local mesh.

bool downlink_enabled = 6;

setId

open fun setId(value: Int): ChannelProtos.ChannelSettings.Builder


Used to construct a globally unique channel ID.
The full globally unique ID will be: "name.id" where ID is shown as base36.
Assuming that the number of meshtastic users is below 20K (true for a long time)
the chance of this 64 bit random number colliding with anyone else is super low.
And the penalty for collision is low as well, it just means that anyone trying to decrypt channel messages might need to
try multiple candidate channels.
Any time a non wire compatible change is made to a channel, this field should be regenerated.
There are a small number of 'special' globally known (and fairly) insecure standard channels.
Those channels do not have a numeric id included in the settings, but instead it is pulled from
a table of well known IDs.
(see Well Known Channels FIXME)

fixed32 id = 4;

setModuleSettings

open fun setModuleSettings(value: ChannelProtos.ModuleSettings): ChannelProtos.ChannelSettings.Builder

open fun setModuleSettings(builderForValue: ChannelProtos.ModuleSettings.Builder): ChannelProtos.ChannelSettings.Builder


Per-channel module settings.

.meshtastic.ModuleSettings module_settings = 7;

setName

open fun setName(value: String): ChannelProtos.ChannelSettings.Builder


A SHORT name that will be packed into the URL.
Less than 12 bytes.
Something for end users to call the channel
If this is the empty string it is assumed that this channel
is the special (minimally secure) "Default"channel.
In user interfaces it should be rendered as a local language translation of "X".
For channel_num hashing empty string will be treated as "X".
Where "X" is selected based on the English words listed above for ModemPreset

string name = 3;

setNameBytes

open fun setNameBytes(value: ByteString): ChannelProtos.ChannelSettings.Builder


A SHORT name that will be packed into the URL.
Less than 12 bytes.
Something for end users to call the channel
If this is the empty string it is assumed that this channel
is the special (minimally secure) "Default"channel.
In user interfaces it should be rendered as a local language translation of "X".
For channel_num hashing empty string will be treated as "X".
Where "X" is selected based on the English words listed above for ModemPreset

string name = 3;

setPsk

open fun setPsk(value: ByteString): ChannelProtos.ChannelSettings.Builder


A simple pre-shared key for now for crypto.
Must be either 0 bytes (no crypto), 16 bytes (AES128), or 32 bytes (AES256).
A special shorthand is used for 1 byte long psks.
These psks should be treated as only minimally secure,
because they are listed in this source code.
Those bytes are mapped using the following scheme:
`0` = No crypto
`1` = The special "default" channel key: {0xd4, 0xf1, 0xbb, 0x3a, 0x20, 0x29, 0x07, 0x59, 0xf0, 0xbc, 0xff, 0xab, 0xcf, 0x4e, 0x69, 0x01}
`2` through 10 = The default channel key, except with 1 through 9 added to the last byte.
Shown to user as simple1 through 10

bytes psk = 2;

setUplinkEnabled

open fun setUplinkEnabled(value: Boolean): ChannelProtos.ChannelSettings.Builder


If true, messages on the mesh will be sent to the *public* internet by any gateway ndoe

bool uplink_enabled = 5;